﻿//-----------------------------------------------------------------------
// <copyright file="ICanvas.cs" company="Nathan Miller">
// Copyright (c) Nathan Miller.
//
// Permission is hereby granted, free of charge, to any person obtaining
// a copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to
// permit persons to whom the Software is furnished to do so, subject to
// the following conditions:
// 
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
// </copyright>
//-----------------------------------------------------------------------
namespace TileTool.Render
{
    using System;
    using System.Windows.Forms;
    using TileTool.Common.Math;
    using TileTool.Input;

    /// <summary>
    /// Interface for a canvas that can be drawn into.
    /// 
    /// The center of the canvas is considered to be (0,0) and the
    /// canvas is expected to operate in the Cartesian coordinate system.
    /// </summary>
    public interface ICanvas
    {
        #region Events

        /// <summary>
        /// Event triggered when the canvas is resized.
        /// </summary>
        event Action<ICanvas> Resized;

        /// <summary>
        /// Event triggered when the canvas should be drawn.
        /// </summary>
        event Action<ICanvas, ICanvasRenderer> Draw;

        /// <summary>
        /// Event triggered when there was input on the canvas.
        /// </summary>
        event Action<ICanvas, InputData> Input;

        #endregion

        #region Properties

        /// <summary>
        /// Gets the control associated with the canvas.
        /// </summary>
        Control Control
        {
            get;
        }
      
        /// <summary>
        /// Gets the width of the canvas.
        /// </summary>
        int Width
        {
            get;
        }

        /// <summary>
        /// Gets the height of the canvas.
        /// </summary>
        int Height
        {
            get;
        }

        #endregion

        #region Methods

        /// <summary>
        /// Create a camera and associate it with this canvas.
        /// </summary>
        /// <returns>Returns a new camera object.</returns>
        ICamera CreateCamera();

        #endregion
    }
}
